home *** CD-ROM | disk | FTP | other *** search
/ Emulator Universe CD / emulatoruniversecd1998.iso / CPC / Utils / CpcFile System / CPCFS.HLP < prev    next >
Encoding:
Text File  |  1996-02-12  |  14.8 KB  |  564 lines
  1. ~nothing~
  2. Type
  3.     HELP <commandname>
  4.  
  5. for information on that command or
  6.  
  7.     HELP <topic>
  8.  
  9. on one of the following general topics:
  10.     commands    options        values        filenames
  11.     percent        variables    invocation    editing
  12.     about        background    bugs
  13.  
  14. ~commands~
  15. List of available commands in alphabetical order:
  16.  
  17. !    ?    attrib    bye    cd    close    cls    comment    copy    del
  18. dir    dira    dpb    dump    echo    era    exit    force    format    get
  19. help    lcd    ldir    map    mget    mode    mput    new    open    page
  20. prompt    put    quit    ren    source    stat    sysgen    type    user  verbosity
  21.  
  22.  
  23. Commands grouped according to functionality:
  24.  
  25. General:        close    open    user
  26. Transfer data:        get    mget    mode    mput    put    sysgen
  27. DOS access:        !    cd    lcd    ldir
  28. CP/M maintenance:    attrib    copy    comment    del    dir    dpb    dump
  29.             era    format    new    ren    stat    type
  30. User interface:        ?    bye    cls    echo    exit    force    help
  31.             verbosity    page    prompt    quit    source
  32. Obsolete:        dira    map
  33.  
  34. ~options~
  35. Standard options for several commands:
  36.     * -c  output to console, when default is output to a pager
  37.     * -f  force overwriting of existing files
  38.     * -b  transfer in binary mode
  39.     * -t  transfer in text mode (up to first Ctrl-Z)
  40.  
  41. The f, b, and t options control the copying process and are available for
  42.     get    mget    put    mput    type    copy
  43. The c option controls the display mode and is available for
  44.     type    dump    stat
  45.  
  46. See also:
  47.     variables (PAGER)    force    mode
  48.  
  49. ~variables~
  50. Used environment variables:
  51.  
  52.     PAGER        command to use for paging (default: internal pager)
  53.     TEMP        directory for temporary files (default: current)
  54.     COMSPEC        specifies the standard command processor for DOS
  55.  
  56. PAGER must point to a program that expects its argument on the commandline, 
  57. and not from stdin, so MORE.COM does not work. V. Buergs's famous LIST does
  58. not work the most time, I don't know why. I recommend LESS.
  59.  
  60. You can get a listing of all enviroment variables with !SET.
  61. See your DOS manual for further documentation about TEMP and COMSPEC.
  62.  
  63. ~percent~
  64. Percent expansions can be used anywhere in strings. They are replaced by
  65. some runtime dependend values:
  66.  
  67.     %u  current user area
  68.     %i  filename of image            %I  including full path
  69.     %f  free space in percent        %F  in blocks
  70.     %a  allocated space in percent        %A  in blocks
  71.     %c  current working directory of DOS
  72.     %v  current version            %V  plus compilation info
  73.  
  74.     %%  the percent sign (%)
  75.     %_  an explicit space
  76.     %#  the hash character (#)
  77.     %e  the escape character
  78.     %q  the quote character (")
  79.     %s  the semicolon character (;)
  80.  
  81. Some expansions show `#', if there is no image loaded!
  82.  
  83. Used in commands:
  84.     comment        echo    prompt
  85.  
  86. ~filenames~
  87. DOS filenames: <drive>:<path>\<root>.<extension>
  88.     * and ?, the normal DOS wildcards, are possible in <root> 
  89.     and <extension>.
  90.  
  91. CP/M filenames: <userarea>:<root>.<extension>
  92. Wildcards:
  93.     *        any sequence of characters
  94.     ?        a single character
  95.     [a-z123]    a set of characters
  96.     [^0-9]        a negative set
  97.  
  98. Note:    * may appear as user number => all users        
  99.  
  100. Example: Files = {ABC.1, ABC.2, ABC.X, X.ABC, 1:USER.ONE}
  101.  
  102.     *:*.*        matches all five files
  103.     *.*        matches ABC.1, ABC.2, ABC.X, X.ABC
  104.     *.?        matches ABC.1, ABC.2 ABC.X
  105.     *.[0-9]     matches ABC.1 ABC.2
  106.     [ab]*.[^0-9]    matches ABC.X
  107.     1:*.*        matches 1:USER.ONE
  108.     1:        sometimes like 1:*.*
  109.  
  110. ~invocation~
  111. Either call CPCfs in interactive mode:
  112.  
  113.     CPCFS
  114.  
  115. or in batch mode:
  116.  
  117.     CPCFS [<image>] <commands>...
  118.  
  119. where
  120.   <image> is the name of the image on which <commands> should be applied
  121.   <commands> are
  122.     -g     get        │    -?    usage message
  123.     -mg    mget        │    -f    toggle force
  124.     -p    put        │    -b    binary mode
  125.     -mp    mput        │    -t    text mode
  126.                 │    -e    execute next commands
  127.     <none>    dir        │
  128.     -d    dir        │    -nd    Create a new data/system/vortex image.
  129.     -s    stat        │    -ns    The imagename must immediately follow
  130.     -x    source        │    -nv    this switch. (e.g. CPCFS -ND FOO)
  131.  
  132. Note: Options after -e are considered as options for CPCfs commands!
  133.       Exitcodes are 0 (ok), 1 (error), or 2 (^C pressed)
  134.  
  135. ~about~
  136. CPCfs - CPCEmu Filessystem Maintenance, Version 0.85 (Feb. 96)
  137.  
  138. This program is Freeware and copyright by Derik van Zütphen.
  139. You may distribute the whole package (zip-file), with or without an
  140. appropriate charge. You may not distribute changed versions.
  141.  
  142. ** This software is provided "as-is". No warranties of any kind are made! **
  143.  
  144. Please send bug reports to
  145.     derik@pool.informatik.rwth-aachen.de
  146.  
  147. ~background~
  148. Record:        the smallest piece of data accessible by CP/M (128 bytes)
  149. Block:        the smallest allocation entity (1024 bytes, vortex: 4096 bytes)
  150. Directory:    the first blocks of the filesystem
  151. Dir.entry:    32 bytes containing the filename and blockpointers
  152. Blockpointer:    one or two bytes pointing to a block of data
  153. Extent:        the amount of blockpointers pointing to 16k of data
  154.  
  155. ~editing~
  156. The following keystrokes are possible while editing a commandline:
  157.     * Curser-Left, -Right
  158.       Ins, Del, <--
  159.       Home, End        have the obvious meaning
  160.     * Cursor-Up, -Down    walk thru the history list
  161.     * Ctrl-Home, -End    delete to start/end of line
  162.     * Ctrl-Z        leave CPCfs
  163.     * ESC            delete commandline
  164.  
  165. The traditonal EMACS contol codes are also possible (^B, ^F, ^V, ^D, ^H,
  166. ^A, ^E, ^P, ^N, ^K, ^U).
  167.  
  168. ~bugs~
  169. The following inconsistencies are intentional:
  170.  
  171.     * weird formats (with interleave or copy protection) are not possible
  172.     * sparse files are not possible    (sometimes created by CP/M programs)
  173.     * wrong setting of environment variables can cause funny errors
  174.     * error messages can be confusing if your DOS disk becomes full
  175.     * your image file must not be readonly
  176.  
  177. ~values~
  178. Numbers:    in C syntax, i.e. decimal, octal with leading "0", 
  179.         hexadecimal with leading "0x".
  180.         Example: USER 15 = USER 017 = USER 0xF
  181.  
  182. Strings:    Surrounded by `"'
  183.         Example: ECHO "Hello World"
  184.  
  185. See also:
  186.     percent
  187.  
  188. ~put~
  189. PUT <options> <dos-filename> [<cpm-filename>]
  190.     Copies a file from DOS to CPC filesystem. If <cpm-filename> is 
  191.     present, <dos-filename> is renamed to that name.
  192. PUT <options> <dos-filename> <userarea>:
  193.     Copies *one* file from DOS to a user area of the CP/M filesystem.
  194.     The colon after <userarea> is important!
  195.  
  196. See also:
  197.     options        filenames
  198.  
  199. ~get~
  200. GET <options> <cpm-filename> [<dos-filename>]
  201.     Copies a file from CPC to DOS filesystem. If <dos-filename> is 
  202.     present, <cpm-filename> is renamed while copying.
  203. GET <options> <cpm-filename>... <dos-path>
  204.     Copies some files form CPC to a DOS directory. <dos-path> must
  205.     end with a backslash (otherwise GET ONE PATH would be ambigous)
  206.  
  207. Example:
  208.     GET FOO            copies to .\FOO
  209.     GET FOO DOSFOO        copies to .\DOSFOO
  210.     GET FOO BAR ..\        copies to ..\FOO and ..\BAR
  211.  
  212. See also:
  213.     options        filenames
  214.  
  215. ~mput~
  216. MPUT <options> <dos-filespec>...
  217.     Same as PUT, but works with wildcards instead of names (m = multiple).
  218.     Renaming on the fly and putting to other user areas is not
  219.     possible here.
  220.  
  221. See also:
  222.     options        filenames
  223.  
  224. ~mget~
  225. MGET <options> <cpm-filespec>...
  226.     Same as GET, but works with wildcards instead of names (m = multiple)
  227.     Renaming on the fly and getting to other directories is not
  228.     possible here.
  229.  
  230. See also:
  231.     options        filenames
  232.  
  233. ~open~
  234. OPEN <file>
  235.     Load an image
  236.  
  237. ~close~
  238. CLOSE
  239.     Close the current image
  240.  
  241. ~new~format~
  242. NEW [-s | -d | -i | -v]  <imagename>
  243. FORMAT ...
  244.     Build a new empty image file
  245.     The available formats are
  246.       * -s  SYSTEM        169k net capacity + CP/M tracks
  247.       * -d  DATA        178k net capacity        (default)
  248.       * -i    IBM        154k net capacity + CP/M tracks
  249.       * -v  VORTEX        708k net capacity + CP/M tracks
  250.  
  251. Note: To access a vortex image from a CPC emulator you need the vortex ROMS!
  252.  
  253. See also:
  254.     sysgen    stat    dpb
  255.     
  256. ~sysgen~
  257. SYSGEN <file>
  258.     Writes the CP/M-System from <file> to current image.
  259.  
  260. Note: The image must be in system format!
  261.  
  262. ~mode~
  263. MODE <mode>            
  264.     Set transfer mode to either Binary, Text, or Auto.
  265.       * Binary    the whole file is processed
  266.       * Text    the file is processed up to the first Ctrl-Z
  267.       * Auto    Binary or Text processing depends on the analysis
  268.             of the file (>70% printable => Text, otherwise Bin)
  269.  
  270. See also:
  271.     options
  272.  
  273. ~dir~
  274. DIR <options> <cpm-filespec>
  275.     Print the directory of the current user area.
  276.     <options> are:
  277.      <none>    (default)    two files per line
  278.       -w    (wide)        four files per line
  279.       -l    (long)        including a lot of information
  280.       -a    (amshead)    including Amsdos Header, if available
  281.       -u    (unsorted)
  282.  
  283. The amount of output:
  284. wide    = name, size
  285. default = wide + user, R/O attribute, more-attributes-mark, alloc. entries
  286. long    = default + all attrib., detected mode, alloc. blocks, alloc. records
  287. amshead = default + Amsdos Header
  288.  
  289. Note: -a, -l, and -w are mutually exclusive!
  290.       Use DIR *:*.* to see all user areas.
  291.  
  292. See also:
  293.     filenames
  294.  
  295. ~attrib~
  296. ATTRIB <attributes>... <cpm-filespec>...
  297.     Set or reset attributes of files.
  298.  
  299. Attributes are:
  300.     R/O        readonly            (i.e. R=ON)
  301.     R/W             readwrite            (i.e. R=OFF)
  302.     DIR        appears in directory        (i.e. S=OFF)
  303.     SYS        system file (used for CP/M 3.0)    (i.e. S=ON)
  304.     A        Archive "on" or "off" (used for CP/M 3.0)
  305.     <extended>    there are 8 extended attributes F1..F8, that can
  306.             be either "on" or "off".
  307.  
  308. Change the R/O, R/W, DIR, and SYS by simply mentioning them with prefixed "-".
  309. Set A and F1..F8 with -A=ON, -F1=OFF, etc.
  310.  
  311. Note: F5..F8 are officially reserved for CP/M!
  312.  
  313. Example:
  314.     ATTRIB -R/O -DIR -F1=ON *.C *.H
  315.  
  316. ~era~del~
  317. DEL [-f] <cpm-filespec>...
  318. ERA [-f] <cpm-filespec>...
  319.     Delete files.
  320.     Ask for permission, if a file is R/O. Do not ask if -f is given.
  321.  
  322. Example:
  323.     DEL *.C *.H    \ Deletes all .C and .H file
  324.     DEL *.[CH]    /
  325.     DEL -f *:*.*      Deletes the whole image!
  326.     DEL 1: 2:      Deletes user 1 and 2
  327.  
  328. ~ren~
  329. REN <from-cpm-filespec> <to-cpm-filespec>
  330. REN <from-cpm-filespec>... <userarea>
  331.         Rename a file or shift a set of files to another user area.
  332.  
  333. Example:
  334.     REN FOO.BAR SENSIBLE.NAM
  335.     REN A.LOT OF FILES.* 1:
  336.  
  337. ~copy~
  338. COPY <options> <from-cpm-filename> <to-cpm-filename>
  339. COPY <options> <cpm-filespec>... <userarea>
  340.     The first form copies a file to a second file.
  341.     The second form copies a set of files to another user area with the 
  342.     same name.
  343.  
  344. Example:
  345.     COPY FOO.BAR SENSIBLE.NAM
  346.     COPY A.LOT OF FILES.* 1:
  347.  
  348. See also:
  349.     options
  350.  
  351. ~type~
  352. TYPE <options> <cpm-filename>
  353.     Writes the content of a file to the screen. If in binary mode or 
  354.     binary mode is detected, the content is translated to hexadecimal.
  355.  
  356. Example:
  357.     TYPE TEXT        assumes detected textmode
  358.     TYPE -B TEXT        force the text to hexdump
  359.  
  360. See also:
  361.     options
  362.  
  363. ~user~
  364. USER <number>[:]
  365.     Set user area. <number> should be in 0 .. 15.
  366.      The USER command itself can be left out.
  367.  
  368. Note: USER 229 does _not_ allow access to deleted files!
  369.  
  370. Example:
  371.     USER 0            back to default user
  372.     USER 0:            (additional colon possible)
  373.     0:            (shortcut form, colon required)
  374.  
  375. ~force~
  376. FORCE
  377.     Toggle ``Ask on overwrite'' switch.
  378.  
  379. The ``Overwrite?'' question appears, if you try to overwrite DOS or CP/M
  380. files with PUT, GET, COPY, REN or if you try to DEL a readonly file.
  381.  
  382. To see the current Force status use STAT.
  383.  
  384. ~map~
  385. The MAP command will be absent in versions. See DUMP -M
  386.  
  387. ~dira~
  388. The DIRA command will be absent in next versions. See DUMP -D
  389.  
  390. ~dump~
  391. DUMP <options> -d    Dump the complete directory structure
  392. DUMP <options> -m    Dump an allocation map
  393. DUMP <options> [ -b# | -h# | -t# | -s# | -1 | -2 ]    Dump some data blocks
  394.  
  395. Directory dump -- shows:
  396.     entry number, first-entry tag ">", user area, name, extent, records,
  397.     attributes, block-pointer, last-entry tag "<<<" or next-entry-pointer ">##"
  398.  
  399. Allocation dump -- shows for each sector:
  400.     $$    CP/M                  │    <num>    Used for file in entry <num>
  401.     DD    Directory              │    --    Not used
  402.  
  403. Data dump -- options:
  404.     -b<block-number>              │    -h<head-number>
  405.     -1    next is start pos (def 0)     │    -t<track-number>
  406.     -2    next is last pos (def start)  │    -s<sector-number>
  407.  
  408. Overall options:
  409.     -c  to stdout/console          │    -f <dos-filename> to a file
  410.  
  411. Example:
  412.     DUMP -B0 -2 -B2                   first three blocks
  413.     DUMP -H0 -T0 -S0 -2 -H1 -Fside    hexdump of one side to a file
  414. ~ldir~
  415. LDIR <dos-filespec>
  416.     Print the current DOS directory.
  417.     Equivalent to !DIR.
  418.  
  419. Example:
  420.     LDIR *.DSK
  421.  
  422. See also:
  423.     !
  424.  
  425. ~lcd~cd~
  426. CD <dos-drive&path>              
  427. LCD <dos-dirve&path>              
  428.     Change the current DOS drive and/or directory.
  429.     This is *not* equivalent to !CD.
  430.  
  431. Example:
  432.     CD C:\TEMP
  433.  
  434. ~stat~
  435. STAT
  436.     Print status information about
  437.       * Format of current image
  438.       * Allocation
  439.       * Internal variables
  440.  
  441. See also:
  442.     comment        dpb
  443.  
  444. ~echo~
  445. ECHO <string>
  446.     Write the string.
  447.     If you have ANSI.SYS loaded, you can use ANSI sequences (see example).
  448.  
  449. Note: Parameters of ANSI sequences must be separated by %s, and not ";"!
  450.  
  451. Example:
  452.     ECHO "The current image is %i"
  453.     ECHO "%e[31%s1mBright Red%e[0m and back to normal"
  454.  
  455. See also:
  456.     percent        values
  457.  
  458. ~source~
  459. SOURCE <scriptfile>
  460.     Execute the commands in <scriptfile>. The script CPCFS.CFG is
  461.     automatically executed at startup of CPCfs.
  462.  
  463. Example:
  464.     SOURCE MY.CFG
  465.  
  466. ~help~?~
  467. HELP <topic>
  468.     Gives help about a command or about a general topic.
  469.     Type help alone to see these topics.
  470.  
  471. The following special characters are used to describe the syntax
  472.       <___>        identifier
  473.       [___]        optional
  474.       __|__        alternative
  475.       (___)        grouping
  476.       ___...    repetition
  477.  
  478. The following special identifier are used:
  479.     <cpm-filename>, <dos-filename>    a filename without wildcards
  480.     <cpm-filespec>, <dos-filespec>    a filename with/without wildcards
  481.     <userarea>            a user number out of 0..15 
  482.  
  483. See also:
  484.     filenames    options
  485.  
  486. ~!~
  487. !<command>
  488.     Execute a DOS command or open a shell, if there is no <command>
  489.  
  490. See also:
  491.     variables (COMSPEC)    ldir    cd
  492.  
  493. ~page~
  494. PAGE <lines>
  495.     If you are using the internal pager (i.e. the environment variable 
  496.     PAGER is not set), this command sets the number of lines the pager
  497.     should display per screen.
  498.  
  499. See also:
  500.     variables (PAGER)
  501.  
  502. ~verbosity~
  503. VERBOSITY <level>
  504.     Set verbosity of CPCfs:
  505.       -1    no output at all
  506.       0    only requested output
  507.       1    + prompt + error messages
  508.       2    + success messages
  509.       3    + progress messages
  510.     Default=9.
  511.  
  512. Note: Verbosity level > 9 are for debugging purposes and require ANSI.SYS!
  513.  
  514. Example:
  515.     VERBOSITY 0    may be sensible in batch processing
  516.  
  517.  
  518. ~prompt~
  519. PROMPT <string>
  520.     Set the prompt. You may use percent expansion.
  521.  
  522. Example:
  523.     PROMPT "Image %i is %a%% full. What now? "
  524.  
  525. See also:
  526.     percent        echo    values
  527.  
  528. ~exit~bye~quit~
  529. BYE
  530. EXIT
  531. QUIT
  532.     Leaves CPCfs.
  533.     You can also type Ctrl-Z as a shortcut.
  534.  
  535. ~dpb~
  536. DPB
  537.     Prints the contents of the current Disk Parameter Block plus
  538.     geometrical information about the image.
  539.  
  540. See also:
  541.     stat    background
  542.  
  543. ~comment~
  544. COMMENT -d
  545.     (DEFAULT) Place CPCEMU's default comment into the image (e.g. for CPE)
  546. COMMENT -n
  547.     (NOW) Places a timestamp in the comment field. This is the default
  548.     for newly created images.
  549. COMMENT <string>
  550.     Set the comment field to an arbitrary string of at least 40 characters.
  551.  
  552. Example:
  553.     COMMENT -D    replacement for DROP_TAG.EXE, see DROPTAG.BAT
  554.  
  555. See also:
  556.     percent
  557.  
  558. ~cls~
  559. CLS
  560.     Clear screen.
  561.  
  562. ~end-of-help~
  563.  
  564.